MarkLogic Server 11.0 Product Documentation
PUT /manage/v2/amps/{id|name}/properties

Summary

This resource address can be used to update the properties for the specified amp.

URL Parameters
format The format of the posted data. Can be either json (default) or xml. This value overrides the Accept header if both are present.
namespace The namespace in which the amped function is defined. This is a required parameter.
document-uri The URI of the document in which the amped function is defined. This is a required parameter.
modules-database The name of the modules database, or omit to specify the filesystem.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the request body, either application/xml or application/json.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, either application/xml or application/json.

Response

Upon success, MarkLogic Server returns status code 204 (No Content). If the payload is malformed or the privilege does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the security and manage-admin roles.

Usage Notes

The structure of the data in the request body is as follows. It is an error to attempt to change any aspect of an amp except the roles.

Note: The properties described here are for XML payloads. In general they are the same for JSON, with the exception that, in JSON, roles is expressed in singular form. For example, in JSON, roles is instead role and the format is: "role":["rolename"].

The structure of the output returned from this REST API is as follows:

local-name

A function local-name.

namespace

A namespace.

document-uri

A document's URI.

modules-database

A database the module is found in.

roles

The roles assigned. The roles assigned to the user.

This is a complex structure with the following children:

role

A role identifier (unique key).

Example


curl -X PUT  --anyauth -u admin:admin -H "Content-Type:application/json" \
-d '{"role": ["manage-internal" ]}' 
http://localhost:8002/manage/v2/amps/create-foo/properties?document-uri=/module/path/name&namespace=http://example.com/uri
 
==>  Changes the amp, named "create-foo," to use the "manage-internal" role.
Powered by MarkLogic Server | Terms of Use | Privacy Policy